Product Offering API
Methods and endpoints
The Product Offering API allows you to:
- search the product offering catalogue for available offers
- view information about product offers
- obtain the Product Offer ID used in the next stage of the ordering process.
The Product Offering API includes the following methods and endpoints:
| Endpoint description | Method and endpoint | Function |
|---|---|---|
| API asset version | GET /version | Retrieve the full version number of the API (major minor and patch version numbers). |
| Product Offers By Query | GET /productOffersByQuery | Retrieve a list of product offers available at an address or location by search options: Place ID, segment name, offer type, product family. |
Mandatory attributes
These attributes are mandatory for the Product Offering API.
| Attribute | Description |
|---|---|
| placeId | Used as a part of GET /productOffersByQuery endpoint. The placeId is a mandatory parameter required to search for available product offers. |
Additional attributes
These additional attributes are applicable to the Product Offering API.
productOfferingsCollection element
| Attribute | Description |
|---|---|
| count | Number of available product offers for the place id |
| total | Total items available |
| items | This is the container of items as an array |
productOffer element
| Attribute | Description |
|---|---|
| items.id | Product offer unique identifier |
| items.productOfferName | Product offer name |
| items.isPrivate | Indicates if the product offer is a private offer |
| items.voiceSupported | Indicates if voice is available on the ONT at location |
| items.productSpecId | Product specification identifier |
| items.productCompatibilityId | Product compatibility identifier |
| items.marketSegment | Market offer segment designation of the product offering |
| items.productOfferType | Product offer type (Primary, Secondary, Not Applicable) |
| items.productFamilyName | Product family name of the product offer |
| items.productClassification | Product classification |
| items.groupName | Product offer group within the product catalogue |
Note: For more information on all available resources, attributes, parameters, field types, length and other restrictions, see the API Specification.